Legrand / Raritan Xerus™ JSON-RPC API for Remote Access Devices like KX4-101, KX3G2
Loading...
Searching...
No Matches
TieredDevicePort.idl
1#ifndef __RADM_TIERED_DEVICE_PORT_IDL__
2#define __RADM_TIERED_DEVICE_PORT_IDL__
3
4#include <UserEvent.idl>
5#include <AccessPort.idl>
6#include <UsbProfileSettings.idl>
7
8module radm {
9
10 interface TieredDevicePort extends AccessPort {
11
12 /** Information about a CIM connected to a port on tier device */
13 valueobject TieredCimInfo {
14 string name; ///< Name as configured in the CIM
15 string cimType; ///< CIM model
16 boolean usbProfilesSupported; ///< If USB profile supported
17 vector<int> selectedProfiles; ///< IDs of USB profiles to be available for this port (available for usbProfiles capability)
18 int activeProfile; ///< ID of active USB profile (available for usbProfiles capability)
19 int preferredProfile; ///< ID of preferred USB profile (available for usbProfiles capability)
20 UsbProfileSettings usbProfile; ///< USB settings handled by profiles on devices with usbProfiles capability, see {@link UsbProfileSettings}
21 };
22
23 /**
24 * Get information about the CIM connected to the port
25 *
26 * @return Tiered CIM Info
27 */
29
30 /** Event: The port information has changed */
31 valueobject TieredCimInfoChangedEvent extends idl.Event {
32 TieredCimInfo oldInfo; ///< Tier Info before change
33 TieredCimInfo newInfo; ///< Tier Info after change
34 };
35 };
36
37}
38
39#endif //__RADM_TIERED_DEVICE_PORT_IDL__
TieredCimInfo getCimInfo()
Get information about the CIM connected to the port.
Basic IDL definitions.
Definition Event.idl:10
Radm Model.
Definition AccessPort.idl:8
Common base for all events.
Definition Event.idl:13
Event: The port information has changed.
TieredCimInfo newInfo
Tier Info after change.
TieredCimInfo oldInfo
Tier Info before change.
Information about a CIM connected to a port on tier device.
string name
Name as configured in the CIM.
vector< int > selectedProfiles
IDs of USB profiles to be available for this port (available for usbProfiles capability)
int preferredProfile
ID of preferred USB profile (available for usbProfiles capability)
boolean usbProfilesSupported
If USB profile supported.
UsbProfileSettings usbProfile
USB settings handled by profiles on devices with usbProfiles capability, see UsbProfileSettings.
int activeProfile
ID of active USB profile (available for usbProfiles capability)